home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr35 / makehlp.zip / MAKEHELP.DOC < prev    next >
Text File  |  1993-04-07  |  6KB  |  212 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.          Make Help  Version 1.00         (C) 1992  Steve Thielemann
  8.  
  9.          TriBBS is copyrighted (C) 1991-1992 Mark D. Goodwin.
  10.  
  11.          Makehelp is a utility that creates help display files for
  12.          your TriBBS system.
  13.  
  14.  
  15.          FILES NEEDED
  16.          ============
  17.  
  18.          MAKEHELP.EXE
  19.          MAIN?.TXT                Help text files for the main menu
  20.          FILES?.TXT               Help text files for the files menu
  21.          MESSAGE?.TXT             Help text files for the message menu
  22.  
  23.  
  24.          HOW MAKEHELP WORKS
  25.          ==================
  26.  
  27.          Makehelp first opens the menu file, and processes the TriBBS
  28.          color information.  This information will be used to create
  29.          an ANSI (.ANS) display file that looks similar to TriBBS's
  30.          generated menus.  Next, it begins processing each line of the
  31.          menu file, checking the security level of that particular
  32.          option.  If it is less than or equal to the security level
  33.          you passed to makehelp, that option is added to the display
  34.          file, and a help text file is merged into the display files.
  35.          (Examples: For the main menu option 'F', makehelp will merge
  36.          MAINF.TXT into the display files.  For the message menu
  37.          option 'C', the merged file would be MESSAGEC.TXT.)
  38.  
  39.  
  40.          CREATING THE DISPLAY FILES
  41.          ==========================
  42.  
  43.          makehelp nwork\MENU seclvl display\MENUH TEXTDIR (optional)
  44.  
  45.          The first parameter 'nwork\MENU' is the path to your TriBBS
  46.          menu that you wish to make a help display for.  The extension
  47.          .MNU is optional.  (Examples: C:\TRITEL\NWORK\FILES.MNU,
  48.          E:\TRIBBS\NWORK\MAIN)
  49.  
  50.          The second parameter is the security level of the highest
  51.          level you wish to have help displayed for.  Usually, this
  52.          will be 10.
  53.  
  54.          The next parameter 'display\MENUH' is the path of the files
  55.          you wish to have created by makehelp.  Makehelp will append
  56.          '.ANS' to the ANSI display file, and '.BBS' to the non-ANSI
  57.          display file.  (Examples: C:\TRITEL\DISPLAY\FILEH,
  58.          E:\TRIBBS\DISPLAY\MAINH)
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.          The last parameter 'TEXTDIR' is optional.  If the help text
  74.          files are in the current directory, the parameter is not
  75.          needed.  Otherwise, specify the help text path.  (Example:
  76.          C:\TRITEL\HELPTEXT, E:\TRIBBS\HELPTEXT)
  77.  
  78.  
  79.          CUSTOMIZING THE HELP TEXT
  80.          =========================
  81.  
  82.          Using any standard text editor, create your help text making
  83.          sure no line exceeds 64 characters in length, and that the
  84.          file is saved in ASCII format.
  85.  
  86.          (Examples: If you wish to create help for your files menu
  87.          option D, you would create or edit the file FILESD.TXT.  For
  88.          your main menu option P, you would create or edit the file
  89.          MAINP.TXT.)
  90.  
  91.  
  92.          CREATING QUICK HELP
  93.          ===================
  94.  
  95.          Change to your TriBBS directory.  Make a directory MAKEHELP.
  96.  
  97.          C:\TRIBBS> MKDIR MAKEHELP
  98.  
  99.          Change to that directory, and unzip the contents of the
  100.          makehelp archive into this directory.
  101.  
  102.          C:\TRIBBS> CHDIR MAKEHELP
  103.          C:\TRIBBS\MAKELP> PKUNZIP C:\QMODEM\DL\MAKEHELP
  104.                                    ^ path to original archive
  105.  
  106.          Use makehelp to create help display files using the default
  107.          help text files.
  108.  
  109.          C:\TRIBBS\MAKEHELP> MAKEHELP C:\TRIBBS\NWORK\MAIN 10
  110.            C:\TRIBBS\DISPLAY\MAINH
  111.            ^ Note: This is all on one line.
  112.          C:\TRIBBS\MAKEHELP> MAKEHELP C:\TRIBBS\NWORK\FILES 10
  113.            C:\TRIBBS\DISPLAY\FILESH
  114.          C:\TRIBBS\MAKEHELP> MAKEHELP C:\TRIBBS\NWORK\MESSAGE 10
  115.            C:\TRIBBS\DISPLAY\MESSAGEH
  116.  
  117.          Now, change over to your TriBBS display directory, and see
  118.          what makehelp did.
  119.  
  120.          C:\TRIBBS\MAKEHELP> CHDIR \TRIBBS\DISPLAY
  121.          C:\TRIBBS\DISPLAY> TYPE MAINH.BBS
  122.          C:\TRIBBS\DISPLAY> TYPE MAINH.ANS
  123.                             ^ You need to have ANSI.SYS loaded to view
  124.                               the .ANS files.
  125.          C:\TRIBBS\DISPLAY> TYPE FILES.ANS
  126.          C:\TRIBBS\DISPLAY> TYPE MESSAGE.ANS
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.          USING THE DISPLAY FILES
  140.          =======================
  141.  
  142.          In order to make use of the display files, you will need to
  143.          get a door program to display files.  I suggest using
  144.          ViewFile, as it works exactly like TriBBS's menus in the
  145.          effect that it aborts with a space.  Also, ViewFile is ready
  146.          made to handle the .BBS/.ANS files depending on the caller's
  147.          ANSI graphics state.
  148.  
  149.          To add main menu help using viewfile:
  150.  
  151.          Edit your NWORK\MAIN.MNU file, and add the option: H,Help,10.
  152.  
  153.          Create a batch file in your main TriBBS called MAINH.BAT
  154.          which will consist of:
  155.  
  156.          VIEWFILE C:\TRIBBS\PCBOARD.SYS C:\TRIBBS\DISPLAY\MAINH
  157.          BOARD
  158.  
  159.  
  160.          SUPPORT
  161.          =======
  162.  
  163.          If you find Makehelp an asset to your BBS, a donation of
  164.          $5.00 is recommended.
  165.  
  166.          The Turbo C source code to Makehelp is available to those
  167.          interested.
  168.  
  169.          You can contact me via modem:
  170.  
  171.          The Luddite BBS (813) 884-3087   300-9600 bauds  24 hours
  172.  
  173.          or via U.S. Mail:
  174.  
  175.          Steve Thielemann
  176.          P.O. Box 733
  177.          New Port Richey, FL  34656-0733
  178.  
  179.  
  180.  
  181.                                   Warranty
  182.                                ==============
  183.  
  184. This product is provided "as is" without warranty of any kind.  The entire
  185. risk as to the results and performance of the program is assumed by you.
  186. Futhermore, I the author do not warrant, guarantee, or make any represent-
  187. tions regarding the use of, or the results of the use of the program, and you
  188. rely on the program and results solely at your own risk. I the author cannot
  189. accept responsibility for system damage, loss of profit, or any other special,
  190. incidental, or consequential damages resulting from the use or inability to
  191. use this product.
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.